home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / lib / recov / recovBox.man < prev   
Encoding:
Text File  |  1992-01-14  |  5.1 KB  |  119 lines
  1. '\" Copyright 1991 Regents of the University of California
  2. '\" Permission to use, copy, modify, and distribute this
  3. '\" documentation for any purpose and without fee is hereby
  4. '\" granted, provided that this notice appears in all copies.
  5. '\" The University of California makes no representations about
  6. '\" the suitability of this material for any purpose.  It is
  7. '\" provided "as is" without express or implied warranty.
  8. '\" 
  9. '\" $Header: /r3/mgbaker/src/cmds/recovTest/RCS/recovBox.man,v 1.1 92/01/07 17:44:29 mgbaker Exp $ SPRITE (Berkeley)
  10. '/" 
  11. .so \*(]ltmac.sprite
  12. .HS recovBox lib
  13. .BS
  14. '\" Note:  do not modify the .SH NAME line immediately below!
  15. .SH NAME
  16. RecovBox_IntObjType, RecovBox_InsertObj, RecovBox_InsertArray, RecovBox_DeleteObj, RecovBox_UpdateObj, RecovBox_ReturnObj, RecovBox_ReturnArray, RecovBox_ReturnContents, RecovBox_GetObjSize, RecovBox_MapType, RecovBox_MapObjectNum \- Routines (actually macros) to add, delete, manipulate and view objects in non-volatile storage.
  17.  
  18. .SH SYNOPSIS
  19. .nf
  20. \fB#include <recovBox.h>\fR
  21. .sp
  22. ReturnStatus *
  23. \fBRecovBox_InitObjType\fR(\fIinitArgsPtr\fP)
  24. .sp
  25. ReturnStatus *
  26. \fBRecovBox_InsertObj\fR(\fIinsertArgsPtr\fP)
  27. .sp
  28. ReturnStatus *
  29. \fBRecovBox_InsertArray\fR(\fIinsertArrayArgsPtr\fP)
  30. .sp
  31. ReturnStatus *
  32. \fBRecovBox_DeleteObj\fR(\fIdeleteArgsPtr\fP)
  33. .sp
  34. ReturnStatus *
  35. \fBRecovBox_UpdateObj\fR(\fIupdateArgsPtr\fP)
  36. .sp
  37. ReturnStatus *
  38. \fBRecovBox_ReturnObj\fR(\fIreturnObjArgsPtr\fP)
  39. .sp
  40. ReturnStatus *
  41. \fBRecovBox_ReturnArray\fR(\fIreturnArrayArgsPtr\fP)
  42. .sp
  43. ReturnStatus *
  44. \fBRecovBox_ReturnContents\fR(\fIreturnTableArgsPtr\fP)
  45. .sp
  46. ReturnStatus *
  47. \fBRecovBox_GetObjSize\fR(\fIgetObjSizeArgsPtr\fP)
  48. .sp
  49. ReturnStatus *
  50. \fBRecovBox_MapType\fR(\fImapTypeArgsPtr\fP)
  51. .sp
  52. ReturnStatus *
  53. \fBRecovBox_MapObjectNum\fR(\fImapObjectNumArgsPtr\fP)
  54.  
  55. .SH ARGUMENTS
  56. .AS XXXXXXX XXXXXXX
  57. .AP Recov_InitObjTypeArgs *initArgsPtr in/out
  58. Pointer to structure containing information about new object type to be created.
  59. One field will return the new object type number.
  60. .AP Recov_InsertObjArgs *insertArgsPtr in/out
  61. Pointer to structure containing information about object to insert in box.
  62. .AP Recov_InsertArrayArgs *insertArrayArgsPtr in/out
  63. Pointer to structure containing information about set of objects to insert in
  64. box.  One field will return the new objects' ID.
  65. .AP Recov_DeleteObjArgs *deleteArgsPtr in
  66. Pointer to structure containing information about the object to delete from
  67. the box.
  68. .AP Recov_UpdateObjArgs *updateArgsPtr in
  69. Pointer to structure containing information about the object to update and how
  70. to update it.
  71. .AP Recov_ReturnObjArgs *returnObjArgsPtr in/out
  72. Pointer to structure containing information about the object to return.  One
  73. field will return the object.
  74. .AP Recov_ReturnArrayArgs *returnArrayArgsPtr in/out
  75. Pointer to structure containing information about the type of objects to return.
  76. One field will contain the array of returned objects of the specified type
  77. number.
  78. .AP Recov_ReturnTableArgs *returnContentsArgsPtr in/out
  79. Pointer to structure containing information about how to return the table
  80. of contents for the box.  One field will return the table of contents.
  81. .AP Recov_GetObjectSizeArgs *getObjectSizeArgsPtr in/out
  82. Pointer to structure containing information about returning the size of
  83. the objects of a given type.  One field will be the returned size.
  84. .AP Recov_MapTypeArgs *mapTypeArgsPtr in/out
  85. Pointer to structure containing information about returning the real typeID
  86. for a given typeID used by an application.
  87. .AP Recov_MapObjectNumArgs *mapObjectNumArgsPtr in/out
  88. Pointer to structure containing information about returning the real object
  89. number for a given object number used by an application.  The real type ID
  90. must be specified in the structure.
  91. .BE
  92.  
  93. .SH DESCRIPTION
  94. .PP
  95. The recovery box will store sets of objects and preserve them across machine
  96. failure.  RecovBox_InitObjType() will initialize a new object type.
  97. The structure
  98. parameter must be filled in with the object size and the maximum number of
  99. objects that will be allowed to exist at once.  See "recovBox.h" for a
  100. description of this structure and all other structure parameters to the
  101. routines described in this manual page.  The other routines make it possible
  102. to insert, update, and delete objects of a given type.  It is also possible
  103. to return the contents of an object, all the objects of a given type, or
  104. to return the table of contents of the recovery box.  For a description of
  105. the what the table of contents looks like, see "recovBox.h."  To make it
  106. possible for different processes to refer to the same types and objects
  107. without needing to know about their order of insertion, types can be
  108. initialized by an application with a special "application typeID," and
  109. likewise, when objects are inserted, they can be given special "application
  110. object numbers."  Then any application can ask what is the real typeID or
  111. real object number for a given application typeID or object number.
  112. .PP
  113. Note that the kernel on the machine may already be using the recovery box,
  114. so that returning its table of contents may show object types already in use
  115. before the user has initialized any types.
  116.  
  117. .SH KEYWORDS
  118. Recovery, non-volatile storage
  119.